Skip to content

docs: genericize getting started and fix apache license#24

Merged
anand-testcompare merged 2 commits into
mainfrom
docs/readme-generic-getting-started
Apr 21, 2026
Merged

docs: genericize getting started and fix apache license#24
anand-testcompare merged 2 commits into
mainfrom
docs/readme-generic-getting-started

Conversation

@anand-testcompare

@anand-testcompare anand-testcompare commented Apr 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  • genericize the getting-started README so it does not assume meshix-api or a specific Databricks warehouse
  • call out the required Convex deployment URL and deploy key near the top of the homepage
  • clarify that .memory/ is only the repo default and that users should override paths as needed
  • switch the documented repo license surface from MIT to Apache 2.0

Verification

  • validated README badge URLs with curl -I
  • cargo test --workspace

Open in Devin Review

devin-ai-integration[bot]

This comment was marked as resolved.

@anand-testcompare anand-testcompare merged commit 4ad6a23 into main Apr 21, 2026
9 checks passed
@anand-testcompare anand-testcompare deleted the docs/readme-generic-getting-started branch April 21, 2026 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant